Macaulay2 » Documentation
Packages » Python » PythonObject » PythonObject ^^ PythonObject » PythonObject ^^= Thing
next | previous | forward | backward | up | index | toc

PythonObject ^^= Thing -- augmented bitwise exclusive disjunction of Python objects

Description

Perform the bitwise exclusive disjunction ("xor") operation on Python objects, and assign the result to the first argument.

i1 : x = toPython 6

o1 = 6

o1 : PythonObject of class int
i2 : x ^^= toPython 3

o2 = 5

o2 : PythonObject of class int
i3 : x

o3 = 5

o3 : PythonObject of class int

If the right-hand side is a Macaulay2 object, then it is first converted to a Python object.

i4 : x = toPython 14

o4 = 14

o4 : PythonObject of class int
i5 : x ^^= 7

o5 = 9

o5 : PythonObject of class int
i6 : x

o6 = 9

o6 : PythonObject of class int

If the Python class of x defines an __ixor__ method for in-place xor, then it will be called. Otherwise, x will xor'ed with y in the usual way, creating a new Python object that is assigned back to x.

For example, NumPy arrays support in-place xor. In the example below, x is modified directly, and no new object is created.

i7 : installNumPyMethods();
i8 : x = toPython matrix {{1, 2}, {3, 4}}

o8 = [[1 2]
      [3 4]]

o8 : PythonObject of class numpy.ndarray
i9 : x ^^= 2

o9 = [[3 0]
      [1 6]]

o9 : PythonObject of class numpy.ndarray
i10 : x

o10 = [[3 0]
       [1 6]]

o10 : PythonObject of class numpy.ndarray

See also

Ways to use this method:


The source of this document is in Python/doc/bitwise.m2:499:0.